vcProduct

A product instance is a data object corresponding to a specific product type and associated to a dynamic component that gives it a physical presence in the 3D world. The product type of product instance can change during its lifetime, but is always explicitly defined. Every product is always linked to exactly one dynamic component, and this linking doesn't change during the product's lifetime.

See in: Overview

Module: vcProcessModel

Parent: vcObject

Children -

Referenced by: vcComponent.Product, vcProductFeed.Product, vcProductType.createProduct()

Properties

Learn how to use properties here. The properties are also inherited from the parent class.

Name	Type	Access	Description
Component	vcComponent	R	Gets the component associated with this product instance.
CurrentProcessFlowState	vcProcessFlowState	RW	Gets or sets the current flow state of this product instance.
LastEnteredNode	vcTransportNode	R	Gets the transport node this product instance has last arrived in. Can be used to determine the product's position along its transport solution.
NextProcessFlowInfo	vcNextProcessFlowInfo	RW	Gets or sets the information used to determine next flow state of this product instance.
ProductType	vcProductType	R	Gets the product type of this product instance.
Properties	vcPropertyContainer	R	Gets the properties of this product instance.
TransportSolution	vcTransportSolution	RW	Gets or sets the transport solution assigned to this product instance. See more Note that the product may already have reached the destination node and continued further by other means.
WorldPositionMatrix	vcMatrix	RW	Gets or sets the product instance position in world coordinates. This takes into account the defined offset between the product's component and the product itself.

Methods

Learn how to use methods here. The methods are also inherited from the parent class.

Name	Return Type	Parameters	Description
changeType	None	vcProductType newType, Optional Keyword[deleteAttachedComponents = Boolean]	Recreates this product instance and its visualization component to match the new product type defined by newType. See more Returns True if successful, False otherwise. Any errors messages are concatenated into a Python error message. Parameters: currentRoutine (vcProcessRoutine): The process implementation this product enters to. deleteAttachedComponents (Boolean): Defines if any other components attached to the component of this product instance are deleted. Exceptions: RuntimeError: When operation fails. Exception message contains the information about the error.
enterProcess	None	vcProcessRoutine currentRoutine	Registers start of given process for this product, updating the current process flow state and next process flow info based on the applicable flow sequence. See more Parameters: currentRoutine (vcProcessRoutine): The process implementation this product enters to.
exitCurrentProcess	None	Boolean clearNextFlowInfo	Registers that this product has left the current process, clearing current process flow state. See more The next process flow info should be cleared when the product is about to enter an assembly or product bundle. Parameters: clearNextFlowInfo (Boolean): Whether to clear next process flow info.